Skip to content

fix: Serialization docs#4007

Open
EmandM wants to merge 2 commits into
develop-2.0.0from
fix/serialization-docs
Open

fix: Serialization docs#4007
EmandM wants to merge 2 commits into
develop-2.0.0from
fix/serialization-docs

Conversation

@EmandM
Copy link
Copy Markdown
Member

@EmandM EmandM commented Jun 2, 2026 •
edited
Loading

Purpose of this PR

  • Adds detail and cross-linking around the serialization docs
  • Moves some docs into the tests and use code embeds to embed the tested code into the docs
  • Deletes the duplicated Custom NetworkVariable section from the NetworkVariable docs
  • Adds a small section about delta updates to the NetworkVariable docs

Jira ticket

UUM-137288
fixes: #2994

Changelog

  • Fixed: UserNetworkVariableSerialization<T>.DuplicateValue is now able to be used anywhere UserNetworkVariableSerialization<T>.ReadDelta and UserNetworkVariableSerialization<T>.WriteDelta can be used.
  • Changed: Updated the serialization docs.

Documentation

  • Includes documentation for previously-undocumented public API entry points.
  • Includes edits to existing public API documentation.

Testing & QA (How your changes can be verified during release Playtest)

Functional Testing

Manual testing :

  • Manual testing done

Automated tests:

  • Covered by existing automated tests
  • Covered by new automated tests

Does the change require QA team to:

  • Review automated tests?
  • Execute manual tests?
  • Provide feedback about the PR?

If any boxes above are checked the QA team will be automatically added as a PR reviewer.

Backports

n/a

@EmandM EmandM requested review from a team and jabbacakes as code owners June 2, 2026 22:49
jabbacakes
jabbacakes approved these changes Jun 5, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@jabbacakes jabbacakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can give me a giant PR, I can give you a giant pile of suggestions. Seems fair 😂

No major notes - this is a great improvement of the serialization docs. So many links 😍 Most of my comments are just wording tweaks, changed the title of a page in a couple of instances to make it clearer what you can actually do with a certain interface at a glance.

Comment thread ...ity.netcode.gameobjects/Documentation~/advanced-topics/serialization/inetworkserializable.md Outdated
Comment thread ...ity.netcode.gameobjects/Documentation~/advanced-topics/serialization/inetworkserializable.md Outdated
Comment thread ...ity.netcode.gameobjects/Documentation~/advanced-topics/serialization/inetworkserializable.md Outdated
Comment thread ...etcode.gameobjects/Documentation~/advanced-topics/serialization/inetworkserializebymemcpy.md Outdated
Comment thread ...ity.netcode.gameobjects/Documentation~/advanced-topics/serialization/inetworkserializable.md Outdated
Comment thread com.unity.netcode.gameobjects/Documentation~/basics/custom-networkvariables.md Outdated
Comment thread com.unity.netcode.gameobjects/Documentation~/basics/custom-networkvariables.md Outdated
Comment thread com.unity.netcode.gameobjects/Documentation~/basics/networkvariable.md Outdated
Comment thread com.unity.netcode.gameobjects/Documentation~/serialization.md Outdated
Comment thread com.unity.netcode.gameobjects/Documentation~/serialization.md Outdated
jabbacakes
jabbacakes approved these changes Jun 5, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@jabbacakes jabbacakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can give me a giant PR, I can give you a giant pile of suggestions. Seems fair 😂

No major notes - this is a great improvement of the serialization docs. So many links 😍 Most of my comments are just wording tweaks, changed the title of a page in a couple of instances to make it clearer what you can actually do with a certain interface at a glance.

@EmandM EmandM mentioned this pull request Jun 5, 2026
Closed
@EmandM @jabbacakes
Apply suggestions from code review
815c063 
Co-authored-by: Amy Reeve <amy.reeve@unity3d.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jabbacakes jabbacakes jabbacakes approved these changes

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

UnmanagedNetworkSerializableSerializer Duplicate Method Causes Errors with Disposable Types Due to Pure Assignment

2 participants

@EmandM @jabbacakes